Get Operator Connect Customer Numbers V2

The Get Operator Connect Customer Numbers V2 request retrieves the numbers that have been acquired through the Operator Connect service for the specified tenant. Each number includes detailed information about its current status, capabilities, location assignments, and associated SBC configurations.

This request requires API access authorization using Azure AD JWT .

URI

Copy 
{{baseUrl}}/api/v2/oc/numbers?msTenantId={{msTenantId}}

HTTP Method

GET

Request Parameters

Parameter

Type

Description

msTenantId

string

Customer's Microsoft Azure Tenant Subscription Id.

Request Body

Parameter

Type

Description

X-Ovoc-Channel-Id

integer channel identifier

Filter access to customers belonging to the specified channel. See Get List of Channels to retrieve channel Ids.

Example Response

Copy 
[
  {
    "id": 12345,
    "telephoneNumber": "+12345678901",
    "tenantId": "12345678-1234-1234-1234-123456789012",
    "assignmentStatus": "Active",
    "acquiredCapabilities": ["calling"],
    "availableCapabilities": ["calling", "sms"],
    "isoCountryCode": "US",
    "locationId": "loc-123",
    "civicAddressId": "addr-456",
    "acquiredOn": "2024-01-15T10:30:00Z",
    "source": "OperatorConnect",
    "sbcList": [
      {
        "fqdn": "sbc1.example.com",
        "port": 5061
      }
    ]
  }
]

HTTP Responses

■ 200 OK

Parameter

Type

Description

uploadTelephoneNumberEntryId

string

Unique identifier of the uploaded number.

source

string

Source interface of the uploaded number; webapi

sbcList

list array

List array including the following parameters:

■ sbcName
■ sbcId

sbcName

string

Name of the SBC device in the Live Platform SQL database.

sbcId

integer

Id of the SBC device that is attached to the tenant service for number management in Live Platform SQL database.

tenantCallingProfileId

integer

The Id of the Calling Profile Template record that is attached to the tenant service. A new record is created each time the template is attached to a customer service. Calling Profile Provisioning templates allow you to apply Calling Profile Templates when applying license (see Create OC Essential Service from Lead with IP Group), adding OC SIP Connections (see Add SIP Connections), uploading numbers (see Upload Operator Connect Numbers to Customer) and releasing numbers (see Release Operator Connect Numbers from Customer). You can then assign each Calling Profile Provisioning template to a different IP Group. For instance, you might want to configure an IP Group with enhanced security settings based on the site location's topology requirements and map it to a Calling Profile tailored for a specific carrier.

This value is assigned to services with IP Group-based SIP Connections; this method is currently not supported using the REST API.

ocSipConnectionName

string

 The name of the OC SIP Connection (for services with SIP Connection type "IP Group").

This value is assigned to services with IP Group-based SIP Connections; this method is currently not supported using the REST API.

ocSipConnectionDescription

string

Short description of the OC SIP Connection.

This value is assigned to services with IP Group-based SIP Connections; this method is currently not supported using the REST API.

umpCustomerGuid

string($guid)

This value is created in the Live Platform customer tenant SQL database directory when a license is applied to the lead Create Service from Lead Overview).

This value is also obtained in the 'Get Task' response when the customer service is created.

ovocChannelId

integer

The Id of the Live Platform channel if the service is attached to a channel.

consentedOn

string($date-time

The date of consent by the Operator.

umpCustomerFullName

string

Full customer name

msCompanyName

string

MSFT

sbcListArray

string

id

integer

.

uploadToAccountJobId

integer

Job Id indicating when the number was uploaded.

whenCreated

string($date-time)

Timestamp indicating when the number was uploaded to Live Platform.

acquiredNumberStatus

integer
■ Active:0 Number is active and synchronized with Microsoft Teams admin center.
■ ReleaseRequested:1 Numbers that you have deleted directly in Live Platform.
■ MarkedForRemoval:2 Numbers that have been deleted by Teams admin center and your approval is needed for deletion.
■ ReadyForRemoval:3 Numbers that have been removed by Teams admin center and approved for deletion by Live Platform. This status ends when the number is removed from Live Platform database. The previous status is MarkedForRemoval.
■ PendingFirstSync:4 Numbers (when first added) that still haven't being synchronized with Microsoft Teams admin center.
■ All: No filter.

telephoneNumber

string

Uploaded Telephone number. A separate record set is retrieved for each phone number.

callingProfileId

string

The Id string for the Microsoft Operator Connect Calling Profile that is attached to the tenant service (see Get Calling Profiles). Each Calling Profile is mapped to an SBC trunk used to manage call functionality for tenant service.

acquiredCapabilities

string

Capabilities acquired from the Calling profile. One of the following values:

■ Inbound Calling with the following matching supported usages:
✔ CallingUserAssignment
✔ FirstPartyAppAssignment
✔ Conference Assignment
■ Outbound Calling with the following matching supported usages:
✔ CallingUserAssignment
✔ FirstPartyAppAssignment
✔ Conference Assignment
■ OC Mobile with the following matching supported usages:
✔ CallingUserAssignment
■ Mobile with the following matching supported usages:
✔ CallingUserAssignment
✔ FirstPartyAppAssignment

availableCapabilities

string

Capabilities available for configuration in the Calling profile:

■ Geographic
■ FirstPartyAppAssignment
■ Office365
■ InboundCalling
■ OutboundCalling
■ UserAssignment
■ SharedCalling

acquiredOn

string($date-time)

Timestamp indicating when the number was uploaded to customer tenant.

isoCountryCode

string

Country Calling dial code configured by customer in Teams admin center. See Country Dialing Codes for a full list of Dialing codes.

tnUploadJobId

string

Job Id for upload to customer account.

locationId

string

Id of the site location (see Get Services Brief Details (V3).

civicAddressId

string

Id of the civicAddress (see Get All OC Leads).

assignmentStatus

list array

Indicates the type of number assignment in the Teams admin center:

■ UserAssigned: Assign number directly to a user.
■ ConferenceAssigned: Assign Service number to an Audio conferencing bridge.
■ VoiceApp: Assign Service number to an Auto attendant or Call queue.
■ ThirdPartyAppAssigned

tenantId

string

Customer tenant Azure subscription tenant Id.

aslcht

string($date-time)

Last successful assignment check time, updated each time after a successful verification.

If there are errors, do not update this field, and do not touch the status itself.

aslsct

string($date-time)

Last status change time (null if not known).

alsvcode

string

Last verification code, numeric, inspired from http status codes:

■ 200 OK
■ 500, 404
■ Set to null in case of never verified

asticks

string($date-time)

Ticks for the iteration session.